Skip to content

Documentation setup, code quality tooling, updated CI/CD, and other changes #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
VeckoTheGecko merged 35 commits into from
Oct 7, 2024
Merged

Documentation setup, code quality tooling, updated CI/CD, and other changes #66

VeckoTheGecko merged 35 commits into from
Oct 7, 2024

Conversation

@VeckoTheGecko
Copy link
Collaborator

@VeckoTheGecko VeckoTheGecko commented Sep 26, 2024 •
edited
Loading

This PR implements the following:

  • Migrate to pre-commit to manage code quality (install pre-commit.ci on the repo so that code quality tooling it automatically run and fixes are pushed)
  • Replace Black and other tools with Ruff (no regression here - same things are being checked, its just consolidated into a single faster tool that is widely used)
    • Enable pyupgrade and some other rules
  • Add contributing document
  • Update dev environment to use conda
  • Update CI
    • now with testing matrix for different versions of Python
    • with Codecov support
  • Add publish to PyPI automated workflows (not yet tested)
  • Add documentation
    • Uses Sphinx with the Furo theme
    • With readthedocs support
    • With nbsphinx support (for converting tutorial notebooks to pages in the website).
    • With api doc generation
  • Add dependabot to keep github actions versions updated
  • Add version information to package (so virtualship.__version__ exists as a variable)
  • Drop support for Python 3.8/3.9 in metadata
  • Install click and create boilerplate for CLI tool
    • CLI is now used by doing virtualship run virtualship fetch and virtualship init (rather than just doing do_expedition). Cleans up the namespace
  • Migrate to a src layout
    • This was needed as the cli tool and the package have the same name, and in bash virtualship defaulted to cd'ing into that folder
  • Update README

Contributes to #64

VeckoTheGecko and others added 9 commits September 25, 2024 18:35
@VeckoTheGecko
Migrate code tooling to use pre-commit and ruff
b6f7a88 
The state of docstring linting in Python is a mess. Pydocstyle and Darglint are both deprecated, and Ruff is currently in preview and doesn't provide 100% parity (and Pydoclint configuration is a bit of a mess, having to use the flake config). ANYWAY, let's just use Ruff without preview mode
@VeckoTheGecko
Enable pyupgrade
d8542c3
@VeckoTheGecko
Nox, documentation, codecoverage, updated workflows (publish and test…
40c5dc0 
…ing)...

Add nox workflow running, documentation generation with ReadTheDocs, coverage support, updated CI with publish workflow and improved testing, contributing guidelines, dependabot, updated pyproject.toml config (pytest/coverage options, updated metadata)

Done with reference to Scientific Python copier template.
@VeckoTheGecko
add version information
b127f26
@VeckoTheGecko
Add code of conduct
15fbb17
@VeckoTheGecko
Add logo
5c714cf
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
801f50a 
for more information, see https://pre-commit.ci
@VeckoTheGecko
Update supported Pythons
8413bde 
Python 3.8/3.9 were already not supported since we used 3.10 features
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
0a4c053 
for more information, see https://pre-commit.ci
@VeckoTheGecko
Copy link
Collaborator Author

VeckoTheGecko commented Sep 26, 2024 •
edited
Loading

A bit of a hiccup in that a dependency that we use for a test (seabird) uses a deprecated standard lib package. I'll look at contributing upstream so that they can add support for Python 3.12 and 3.13

EDIT: Done castelao/seabird#78

@VeckoTheGecko
Copy link
Collaborator Author

VeckoTheGecko commented Sep 26, 2024

readthedocs will only be configured once we merge into main (since it will look at the default branch for the conf)

@codecov-commenter
Copy link

codecov-commenter commented Sep 26, 2024

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@VeckoTheGecko
Copy link
Collaborator Author

VeckoTheGecko commented Sep 26, 2024

I think that's pretty much it for this PR. I think we can sit down separately @ammedd to come up with a new readme and to populate the documentation website.

Publishing to PyPI and conda can come after we discuss a bit on how students can use this in the classroom :)

@VeckoTheGecko VeckoTheGecko requested review from ammedd and erikvansebille and removed request for ammedd September 26, 2024 17:04
erikvansebille
erikvansebille reviewed Sep 27, 2024
View reviewed changes
@VeckoTheGecko
Copy link
Collaborator Author

VeckoTheGecko commented Oct 3, 2024

Pypi is done! https://pypi.org/project/virtualship/
Conda is a WIP conda-forge/staged-recipes#27759

This PR is good to go ⛴️. Waiting on green ✅

@VeckoTheGecko
remove py3.13 support
16fcc79 
release got pushed back by a week :P
@VeckoTheGecko VeckoTheGecko enabled auto-merge (squash) October 3, 2024 10:56
@VeckoTheGecko
Copy link
Collaborator Author

VeckoTheGecko commented Oct 3, 2024

Ahhh, I need an approving review to merge. I guess that's a good thing :')

@VeckoTheGecko VeckoTheGecko disabled auto-merge October 3, 2024 13:02
@VeckoTheGecko
Copy link
Collaborator Author

VeckoTheGecko commented Oct 3, 2024 •
edited
Loading

Getting a really strange error when testing on linux... Not sure how to debug this, and all my Google searches come up empty. Only idea I have is to try micromamba in CI

image

@VeckoTheGecko
switch to micromamba ci
1b39b91
@VeckoTheGecko
update code of conduct
46fd185 
Project team contact details already in readme
erikvansebille
erikvansebille reviewed Oct 7, 2024
View reviewed changes
VeckoTheGecko and others added 3 commits October 7, 2024 15:42
@VeckoTheGecko @erikvansebille
Update README.md
e66c2f5 
Co-authored-by: Erik van Sebille <erikvansebille@gmail.com>
@VeckoTheGecko @erikvansebille
Update docs/quickstart.md
1d54956 
Co-authored-by: Erik van Sebille <erikvansebille@gmail.com>
@VeckoTheGecko
review feedback
705973e
@VeckoTheGecko VeckoTheGecko merged commit d9e8348 into main Oct 7, 2024
@VeckoTheGecko VeckoTheGecko deleted the v/dev branch October 7, 2024 13:57
This was referenced Oct 17, 2024
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@erikvansebille erikvansebille erikvansebille approved these changes

@ammedd ammedd Awaiting requested review from ammedd

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@VeckoTheGecko @codecov-commenter @erikvansebille @ammedd